/* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 Validity Systems Inc.  All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in
*    the documentation and/or other materials provided with the
*    distribution.
*
* 3. The end-user documentation included with the redistribution, if
*    any, must include the following acknowlegement:
*       "This product includes software developed by the
*        Validity Systems Inc."
*    Alternately, this acknowlegement may appear in the software itself,
*    if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "#Logger", "CS Logger", and "Validity Systems
*    Inc." must not be used to endorse or promote products derived
*    from this software without prior written permission. For written
*    permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "#Logger"
*    nor may "#Logger" appear in their names without prior written
*    permission of Validity Systems Inc.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Validity Systems Inc.
*
*
*/

namespace VS
{
    using System;
    using System.Collections;
    using System.Collections.Generic;
    using System.IO;
    using System.Threading;

    /// <summary>
    /// Simple To File Logger.  All messages a written out to a flat text file.
    /// </summary>
    public sealed class TextFileLogger : LoggerHandler, IDisposable
    {
        #region Fields
        private StreamWriter stream;
        private bool append = true;
        #endregion

        #region Constructors
        /// <summary>
        /// Initializes a new instance of the TextFileLogger class.
        /// </summary>
        /// <param name="fileName">File name of the log file.</param>
        public TextFileLogger(string fileName)
        {
            if (fileName != null)
            {
                FileMode fm;

                if (this.append)
                {
                    fm = FileMode.Append;
                }
                else
                {
                    fm = FileMode.Create;
                }

                FileStream fs = new FileStream(fileName, fm, FileAccess.Write, FileShare.Read);
                this.stream = new StreamWriter(fs, System.Text.Encoding.UTF8, 4096);
                this.stream.AutoFlush = true; // this is logger, so I want the file to be always written on the disk
            }
        }
        #endregion

        #region Properties
        /// <summary>
        /// Gets or sets a value indicating whether to append the file.
        /// </summary>
        public bool Append
        {
            get { return this.append; }
            set { this.append = value; }
        }
        #endregion

        #region IDisposable Members
        /// <summary>
        /// Flushes and closes the stream.
        /// </summary>
        public void Dispose()
        {
            if (this.stream != null)
            {
                this.stream.Flush();
                this.stream.Close();
            }
        }
        #endregion

        #region Protected methods
        /// <summary>
        /// Logs a LoggerMessage message.
        /// </summary>
        /// <param name="message">LoggerMessage to log.</param>
        protected override void Log(LoggerMessage message)
        {
            if (this.stream == null)
            {
                return;
            }

            string time = System.DateTime.FromFileTime(message.Time).ToString();
            this.stream.Write("[" + time + " [" + message.Level + ":" + message.LevelDescription + " (" + message.Tag + ")] " + message.Message + " ]" + Environment.NewLine);
        }

        /// <summary>
        /// Flushes and closes the stream.
        /// </summary>
        protected override void OnShutdown()
        {
            if (this.stream != null)
            {
                this.stream.Flush();
                this.stream.Close();
            }
        }
        #endregion
    }
}
